QuickTime 3 Reference

Previous | Chapter Top | Chapter Contents | Next

Instrument Component Functions

This section describes functions that are implemented by instrument components.

InstrumentGetInfo

The InstrumentGetInfo function returns information about all the atomic instruments supported by an instrument component.

extern pascal ComponentResult InstrumentGetInfo(
                     ComponentInstance ci,
                     long getInstrumentInfoFlags,
                     InstCompInfoHandle *instInfo)
ci
The instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
instInfo
On exit, an instrument information list Complete Instrument Information List .
function result
A result code.

InstrumentGetInst

The InstrumentGetInst function returns an atomic instrument.

extern pascal ComponentResult InstrumentGetInst(
                     ComponentInstance ci,
                     long instID,
                     AtomicInstrument *atomicInst,
                     long flags)
ci
The instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
instID
The instrument component instrument ID from the information list structure returned by the InstrumentGetInfo function.
atomicInst
On exit, the atomic instrument.
flags
Specify what pieces of information about an atomic instrument the caller is interested in. Atomic Instrument Information Flags
function result
A result code.

InstrumentInitialize

Used by developers of instrument components, this is a call the instrument component makes to the base class instrument component to tell it how to interpret the instrument component resources.

extern pascal ComponentResult InstrumentInitialize(
                     ComponentInstance ci,
                     long initFormat,
                     void *initParams)
ci
An instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
initFormat
Set to zero.
initParams
Set to NULL .
function result
A result code.

InstrumentOpenComponentResFile

The InstrumentOpenComponentResFile function opens the resource file containing the instruments in the instrument component and makes it the current resource file.

extern pascal ComponentResult InstrumentOpenComponentResFile(
                     ComponentInstance ci,
                     short *resFile)
ci
The instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
resFile
On exit, a resource reference.
function result
A result code.

InstrumentCloseComponentResFile

The InstrumentCloseComponentResFile function closes a resource file.

extern pascal ComponentResult InstrumentCloseComponentResFile(
                     ComponentInstance ci,
                     short resFile)
ci
The instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
resFile
A reference to the resource file that was returned previously by the InstrumentOpenComponentResFile function.
function result
A result code.

InstrumentGetComponentRefCon

The InstrumentGetComponentRefCon function gets the reference constant for an instrument component.

extern pascal ComponentResult InstrumentGetComponentRefCon(
                     ComponentInstance ci,
                     void **refCon)
ci
The instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
refCon
A reference constant.
function result
A result code.

InstrumentSetComponentRefCon

Use the InstrumentSetComponentRefCon function to override the Component Manager SetComponentRefCon function and set the instrument component's reference constant to a specified value.

extern pascal ComponentResult InstrumentSetComponentRefCon(
                     ComponentInstance ci,
                     void *refCon)
ci
The instrument component instance. You obtain the identifier from the Component Manager's OpenComponent function. See the chapter "Component Manager" in Inside Macintosh: More Macintosh Toolbox for details.
refCon
A reference constant.
function result
A result code.
© 1997 Apple Computer, Inc.

Previous | Chapter Top | Chapter Contents | Next